Helps Formats

Documentation Formats

Metrowerks documentation comes in a number of formats. We use a single master source document to create all our delivery documents, so you'll find the same information regardless of format.
Most CodeWarrior documentation is available in one or more of these formats:

Format

Ext.

Platform

Purpose

Acrobat

PDF

Windows/ Mac OS/ Solaris

online/printing

HTML

HTM

Windows/ Mac OS/ Solaris

online

WinHelp

HLP

Windows

online

QuickHelp

QH

Mac OS

online

HyperHelp

HH

Solaris

online

PostScript

PS

Linux

printing

Each format has a viewer application. WinHelp is, of course, an integral part of Windows 95/98/NT. CodeWarrior also includes a free copy of Internet Explorer for HTML browsing. The Acrobat, QuickHelp, and HyperHelp viewer applications come with CodeWarrior.

HLP

flags WinHelp format for Windows 95/98/NT. Use WinHelp for online viewing.

HTM

flags the HTML format. Who would have guessed? You may use any web browser as an HTML viewer.

MAC 8.5: Copy the HTM files to a hard disk, then use Sherlock to index the volume and perform fast and efficient searches.

PDF

flags the Adobe Acrobat format. Acrobat Reader allows you to both view and print documentation on Windows 95/98/NT, Mac, or UNIX systems. Each manual in Acrobat has an electronic table of contents, hypertext links in the text, linked index, and is fully searchable.

QH

flags QuickHelp database format for Mac OS. The QuickHelp application is similar to WinHelp. It provides hypertext and searching.

HH

flags HyperHelp database format for Solaris. The HyperHelp application is similar to WinHelp. It provides hypertext and searching.

For questions, bug reports, and suggestions, please use the email report forms in the Release Notes folder, and mail them to cw_support@metrowerks.com.

Windows Instructions

NOTE: With CWP5, the WinHelp files are located in the Help folder within the Metrowerks folder. In subsequent releases, these files will migrate to the CodeWarrior Help folder.

Installing Help Files

1. Insert the CodeWarrior Reference CD.

2. Locate the help files to install.

3. Copy the help files to your hard drive.

By default, the CodeWarrior help files are installed at the following location:
\Program Files\Metrowerks\CodeWarrior\Help

If you modified the path during installation, you'll need to locate the folder using the modified path instead.

4. Delete the Online Help.hlp file.

5. Run CodeWarrior.

The CodeWarrior IDE appears on the screen.

6. Choose CodeWarrior IDE from the Help menu.

The WinHelp index is rebuilt.

Removing Help Files

You may wish to remove some online help files either because you do not think you will use them or just to free up disk space. Follow the directions below to accomplish this.
1. Locate the CodeWarrior Help files.

By default, the CodeWarrior help files are installed at the following location:
\Program Files\Metrowerks\CodeWarrior\Help

2. Select the files to delete.

The selected files are highlighted.
Note that each component has two files associated with it, a '.hlp' and a '.cnt' file. You should remove both when deleting a component's help file.

3. Delete the files.

Press the Delete key to remove the selected files.

4. Delete the Online Help.hlp help file.

Select both the Online Help.hlp and the Online Help.cnt files, then press the Delete key.

5. Run CodeWarrior.

The CodeWarrior IDE appears on the screen.

6. Choose CodeWarrior IDE from the Help menu.

The WinHelp index is rebuilt.

Mac OS Instructions

Installing Help Files

If you did not perform a Full Install of CodeWarrior, you may find yourself needing the information in other online help files. Follow the directions below to install these additional files.
1. Locate the CodeWarrior Help files.

The QuickHelp files are on the CodeWarrior Tools CD and located in the CodeWarrior Help folder. Open the CodeWarrior Help folder to view the online help files.

2. Select the files to install.

The selected help files are highlighted.

3. Copy the files.

Drag the selected files to the CodeWarrior Help folder on your hard drive.

4. Double-click any QuickHelp file.

The QuickHelp application opens and displays the chosen QuickHelp help file.

Removing Help Files

You may wish to remove some online help files either because you do not think you will use them or just to free up disk space. Follow the directions below to accomplish this.
1. Locate the CodeWarrior Help files.

The QuickHelp files are in the CodeWarrior Help folder on your hard drive.

2. Select the files to remove.

The selected help files are highlighted.

3. Drag the files to the Trash.

The QuickHelp help files appear in the Trash.

4. Choose Empty Trash from the Special menu.

The help files are removed from your hard drive.

Format	Ext.	Platform	Purpose
Acrobat	PDF	Windows/ Mac OS/ Solaris	online/printing
HTML	HTM	Windows/ Mac OS/ Solaris	online
WinHelp	HLP	Windows	online
QuickHelp	QH	Mac OS	online
HyperHelp	HH	Solaris	online
PostScript	PS	Linux	printing

HLP	flags WinHelp format for Windows 95/98/NT. Use WinHelp for online viewing.
HTM	flags the HTML format. Who would have guessed? You may use any web browser as an HTML viewer. MAC 8.5: Copy the HTM files to a hard disk, then use Sherlock to index the volume and perform fast and efficient searches.
PDF	flags the Adobe Acrobat format. Acrobat Reader allows you to both view and print documentation on Windows 95/98/NT, Mac, or UNIX systems. Each manual in Acrobat has an electronic table of contents, hypertext links in the text, linked index, and is fully searchable.
QH	flags QuickHelp database format for Mac OS. The QuickHelp application is similar to WinHelp. It provides hypertext and searching.
HH	flags HyperHelp database format for Solaris. The HyperHelp application is similar to WinHelp. It provides hypertext and searching.